<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>NVTX C API Reference: nvtxCounterBatch_t Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">NVTX C API Reference<span id="projectnumber">&#160;v3</span>
   </div>
   <div id="projectbrief">NVIDIA Tools Extension Library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle"><div class="title">nvtxCounterBatch_t Struct Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Helper struct to submit a batch of counters.  
 <a href="structnvtx_counter_batch__t.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="nv_tools_ext_counters_8h_source.html">nvToolsExtCounters.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a55051fa530e11935d88669e619c6b6a4" id="r_a55051fa530e11935d88669e619c6b6a4"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_counter_batch__t.html#a55051fa530e11935d88669e619c6b6a4">counterId</a></td></tr>
<tr class="separator:a55051fa530e11935d88669e619c6b6a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4196d6a8a534213ac31222cc19fb174e" id="r_a4196d6a8a534213ac31222cc19fb174e"><td class="memItemLeft" align="right" valign="top">const void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_counter_batch__t.html#a4196d6a8a534213ac31222cc19fb174e">counters</a></td></tr>
<tr class="separator:a4196d6a8a534213ac31222cc19fb174e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ada5def99a25f1654b55a7b92e02846dd" id="r_ada5def99a25f1654b55a7b92e02846dd"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_counter_batch__t.html#ada5def99a25f1654b55a7b92e02846dd">countersSize</a></td></tr>
<tr class="separator:ada5def99a25f1654b55a7b92e02846dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3b577fef504751dfe3427916f6e273d8" id="r_a3b577fef504751dfe3427916f6e273d8"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_counter_batch__t.html#a3b577fef504751dfe3427916f6e273d8">flags</a></td></tr>
<tr class="separator:a3b577fef504751dfe3427916f6e273d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a22e39eb11f801703154a9530474991ac" id="r_a22e39eb11f801703154a9530474991ac"><td class="memItemLeft" align="right" valign="top">const int64_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_counter_batch__t.html#a22e39eb11f801703154a9530474991ac">timestamps</a></td></tr>
<tr class="separator:a22e39eb11f801703154a9530474991ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb5cc56e00d8bdb1edc1058d4c36ef35" id="r_afb5cc56e00d8bdb1edc1058d4c36ef35"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_counter_batch__t.html#afb5cc56e00d8bdb1edc1058d4c36ef35">timestampsSize</a></td></tr>
<tr class="separator:afb5cc56e00d8bdb1edc1058d4c36ef35"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Helper struct to submit a batch of counters. </p>
<p>The size of one sample is specified via the <code>payloadStaticSize</code> field of the counter's data layout schema or the size of the predefined payload entry type and must include padding. There should be no remainder when dividing <code>countersSize</code> by <code><a class="el" href="structnvtx_payload_schema_attr__t.html#a30c5c448071bcc470f99ff3b76c29a47" title="The binary payload size in bytes for static payload schemas.">nvtxPayloadSchemaAttr_t::payloadStaticSize</a></code>. </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_counters_8h_source.html#l00147">147</a> of file <a class="el" href="nv_tools_ext_counters_8h_source.html">nvToolsExtCounters.h</a>.</p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a55051fa530e11935d88669e619c6b6a4" name="a55051fa530e11935d88669e619c6b6a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a55051fa530e11935d88669e619c6b6a4">&#9670;&#160;</a></span>counterId</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint64_t nvtxCounterBatch_t::counterId</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Identifier of a counter group (data layout, scope, etc.). All counter samples in the batch have the same layout and size. </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_counters_8h_source.html#l00153">153</a> of file <a class="el" href="nv_tools_ext_counters_8h_source.html">nvToolsExtCounters.h</a>.</p>

</div>
</div>
<a id="a4196d6a8a534213ac31222cc19fb174e" name="a4196d6a8a534213ac31222cc19fb174e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4196d6a8a534213ac31222cc19fb174e">&#9670;&#160;</a></span>counters</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const void* nvtxCounterBatch_t::counters</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Batch of counter (group) samples. </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_counters_8h_source.html#l00156">156</a> of file <a class="el" href="nv_tools_ext_counters_8h_source.html">nvToolsExtCounters.h</a>.</p>

</div>
</div>
<a id="ada5def99a25f1654b55a7b92e02846dd" name="ada5def99a25f1654b55a7b92e02846dd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ada5def99a25f1654b55a7b92e02846dd">&#9670;&#160;</a></span>countersSize</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t nvtxCounterBatch_t::countersSize</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Size of the counter batch (in bytes). </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_counters_8h_source.html#l00159">159</a> of file <a class="el" href="nv_tools_ext_counters_8h_source.html">nvToolsExtCounters.h</a>.</p>

</div>
</div>
<a id="a3b577fef504751dfe3427916f6e273d8" name="a3b577fef504751dfe3427916f6e273d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3b577fef504751dfe3427916f6e273d8">&#9670;&#160;</a></span>flags</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint64_t nvtxCounterBatch_t::flags</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Timestamp ordering, timestamp style, etc. See <code>NVTX_BATCH_FLAG_*</code> and <code>NVTX_COUNTER_BATCH_FLAG_*</code>. </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_counters_8h_source.html#l00165">165</a> of file <a class="el" href="nv_tools_ext_counters_8h_source.html">nvToolsExtCounters.h</a>.</p>

</div>
</div>
<a id="a22e39eb11f801703154a9530474991ac" name="a22e39eb11f801703154a9530474991ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a22e39eb11f801703154a9530474991ac">&#9670;&#160;</a></span>timestamps</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const int64_t* nvtxCounterBatch_t::timestamps</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Array of timestamps or a timestamp/interval pair. This field can be <code>NULL</code>, if timestamps are included in the counter samples as part of the counter group layout. By default, one timestamp per sample is assumed. The timestamp source is specified via time semantics passed during the counter group registration. This overrides the timestamps embedded in counter samples. </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_counters_8h_source.html#l00175">175</a> of file <a class="el" href="nv_tools_ext_counters_8h_source.html">nvToolsExtCounters.h</a>.</p>

</div>
</div>
<a id="afb5cc56e00d8bdb1edc1058d4c36ef35" name="afb5cc56e00d8bdb1edc1058d4c36ef35"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afb5cc56e00d8bdb1edc1058d4c36ef35">&#9670;&#160;</a></span>timestampsSize</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t nvtxCounterBatch_t::timestampsSize</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Size of the timestamps array or timestamp/interval pair (in bytes). </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_counters_8h_source.html#l00178">178</a> of file <a class="el" href="nv_tools_ext_counters_8h_source.html">nvToolsExtCounters.h</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="nv_tools_ext_counters_8h_source.html">nvToolsExtCounters.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
